Fix typos in the documentation - #16

Thanks for spotting these with codespell.

Since you used codespell to identify them, would you be willing to suggest how you would integrate it into this repository so that similar issues are caught automatically in the future? For example, perhaps as part of the existing CI workflow or as a pre-commit check. I’m aiming for strong, sustainable long-term solutions rather than one-off fixes.

I’d be interested in what you think would be the most appropriate setup for this project, including how you would deal with project-specific words or false positives.

@ifilot Yes, i think i can integrate that. I would say a warning on a build would help with it.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.76%. Comparing base (6442610) to head (f28f429).

@@            Coverage Diff             @@
##           master      #16      +/-   ##
==========================================
+ Coverage   77.58%   77.76%   +0.18%     
==========================================
  Files          10       10              
  Lines        1111     1111              
  Branches      533      533              
==========================================
+ Hits          862      864       +2     
+ Misses        178      176       -2     
  Partials       71       71              

@goelakash Thanks! The workflow is running, but from the Actions log it looks like the new .codespellrc and .codespell-ignore are not actually being picked up. The log shows Config '' and Ignore words file '', with only --skip ./.git being passed.

Could you update the workflow so the action explicitly uses the repository config/ignore file?

It might also be useful to save the codespell output as a workflow artifact (for example, a codespell.txt report), so warnings are easy to inspect after the run instead of only being visible in the job log.

Done both.

One thing though: the config was already being used. codespell reads .codespellrc from the working directory on its own, so Config '' in the log is just the action showing its own unset input. On that branch I get 3 findings with the file there and 182 with it moved aside.

Passing it explicitly anyway since it is clearer, and added the codespell.txt artifact.

Example run, with three typos I added on purpose so there is something to see:
https://github.com/goelakash/den2obj/actions/runs/34100828446